/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Nesta anotação estão definidas as propriedades para uma coluna do grid.
 *
 * @author Glauco
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ColumnDefinition {
   
    /**
     * Representa os nomes para construção do grid.
     * @return Retorna um array de nomes para esta definição de um grid.
     */
    public String[] alias() default "";

    /**
     * Nome da coluna no grid.
     * @return Retorna o nome da coluna.
     */
    public String name();

    /**
     * Indice da coluna no grid.
     * @return Retorna o indice da coluna no grid.
     */
    public int index() default 0;

    /**
     * Indica se a coluna do grid será editável.
     * Esta opção não é utilizada em buscas ou pesquisa, onde todas as colunas
     * serão apenas para mostrar os dados, e não altera-los.
     * @return Retorna se a coluna é editável.
     */
    public boolean editable() default true;

    /**
     * Largura da Coluna em pixel.
     * @return Retorna a largura da coluna em pixel.
     */
    public int width() default 160;

    /**
     * Propriedades adicionais para a definição.
     */
    public Property[] properties() default {};
}
